home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / sf33_2.zip / SFSYSTEM.ZIP / SFSYSTEM.DOC < prev    next >
Text File  |  1993-03-03  |  25KB  |  560 lines

  1.                              SFSYSTEM.EXE
  2.                              Version 1.3
  3.                          Written by Mike Woltz
  4.                          Buffalo Creek Software
  5.     
  6.     
  7.     INTRODUCTION
  8.     ------------
  9.                          
  10.        SFSYSTEM.EXE is a companion utility for SPITFIRE Bulletin Board
  11.     System software and will allow a number of system configuration
  12.     options to be set outside the SPITFIRE program.  Using SFSYSTEM.EXE's
  13.     command line parameters, a number of options can now be toggled
  14.     on or off and values can be changed thru a scheduled event.
  15.     
  16.        SFSYSTEM.EXE must reside in your SPITFIRE WORK directory where
  17.     your SFSYSTEM.DAT exists.  If SFSYSTEM.DAT is not found, SFSYSTEM.EXE
  18.     provides you with the option of creating it.
  19.  
  20.  
  21.     MENU DRIVEN USAGE
  22.     -----------------
  23.  
  24.        When SFSYSTEM.EXE is executed from the DOS prompt without any of
  25.     its optional command line parameters, a menu is displayed to the user
  26.     showing the available options.  The menu will look like this:
  27.     
  28.     >>>>>>>>   MAIN MENU   <<<<<<<<
  29.     <D>... Display Command Line Usage       <N>... Numeric Values
  30.     <S>... Sysop Data                       <T>... Toggle Switches
  31.     <Q>... Quit
  32.     ENTER COMMAND - [D N S T Q]?
  33.         
  34.     After making a selection, except Q to Quit, a window will open
  35.     up on the screen which displays all the features which can be
  36.     modified for the option you have selected.  As each window opens, 
  37.     the current setting will be shown to you for each feature.  Pressing 
  38.     the ESC key will always return to the previous screen.  Pressing Q 
  39.     will terminate program execution and you will be returned to the 
  40.     DOS prompt.  
  41.     
  42.     
  43.     DISPLAY COMMAND LINE USAGE
  44.     --------------------------        
  45.     
  46.        When this option is selected a window will open up displaying
  47.        the following command line usage parameters available with
  48.        SFSYSTEM:
  49.        
  50.   /L[x] = Log On Time Limit...................[x] = Number Of Minutes
  51.   /O[x] = Daily Log On Limit..................[x] = Amount Of Log Ons
  52.   /T[x] = Daily Time Limit....................[x] = Number Of Minutes
  53.   /V[x] = U/D Ratio Violation Security........[x] = Altered Security Level
  54.  
  55.     /B- = NU Birthdate Not Required           /B+ = NU Birthdate Required
  56.     /D- = Unrequired Door Return Password     /D+ = Require Door Password
  57.     /F- = Test Files Upon Boot Turned Off     /F+ = Test Files Upon Boot
  58.     /P- = NU Default Procotol Off             /P+ = NU Default Procotol On
  59.     /S- = Scan Queued Msg Conferences Only    /S+ = Scan All Msg Conferences
  60.  
  61.  
  62.        These options can be used as command line parameters for toggling
  63.        the selected features ON and OFF via SPITFIRE's scheduled events.  
  64.        More detailed information on how this is accomplished is discussed 
  65.        in the section, Usage As A Scheduled Event. 
  66.  
  67.  
  68.     TOGGLE SWITCHES
  69.     ---------------
  70.        Selecting Toggle Switches will enable the Sysop to toggle the 
  71.     following SPITFIRE features:
  72.     
  73.  
  74.        <A>  U.S. Phone Format
  75.  
  76.              This allows the Sysop to set whether the BBS will use a US 
  77.              phone number format (###-###-####) or allow for SPITFIRE to
  78.              merely accept any 12 character string entered by the user.  
  79.              The SPITFIRE default is set for the US Phone Number Style.
  80.  
  81.        
  82.        <B>  Convert File Description
  83.                    
  84.              This feature allows the Sysop to toggle SPITFIRE's File 
  85.              Description Conversion On and Off.  When this is toggled On, 
  86.              SPITFIRE will automatically convert the first character of 
  87.              each word in the file description to uppercase.  All other 
  88.              characters will be lower case.  If this feature is toggled 
  89.              Off, SPITFIRE makes no attempt to alter the description 
  90.              entered by the caller.  SPITFIRE, by default, sets this 
  91.              feature On.
  92.  
  93.        <C>  Uploaded By Description
  94.        
  95.               This toggle allows the Sysop to configure SPITFIRE to add
  96.               the name of the caller uploading a file to the file description
  97.               of the uploaded file.  If this is toggled to Yes, a name of
  98.               the caller uploading a file is added to the file description.
  99.               
  100.       <D>  Password Failure Comment
  101.         
  102.              This option allows you to toggle whether you wish to configure
  103.              your BBS to allow a caller who has failed their password test
  104.              to be able to leave you a comment before being logged off.  When
  105.              this is toggled on, SPITFIRE will allow a caller to leave a 
  106.              comment when a caller attempts to log on and is unable to enter
  107.              the correct password.
  108.  
  109.       <E>  New User Default Protocol
  110.  
  111.            This feature is used to determine if a new user logging on the
  112.            BBS can select a default file transfer protocol after completing
  113.            the new user questionnaire.  If this is toggled to Yes, the new
  114.            user will be presented with this option.  If this feature is set 
  115.            Off, the new user will not automatically be presented with this
  116.            option, but may still select a default file transfer protocol
  117.            from the <Y>...Your Statistics option of the Main Menu.
  118.  
  119.       <F>  Require New User Birthdate
  120.   
  121.            This feature allows the Sysop to designate whether a new user
  122.            logging onto the BBS for the first time will be required to
  123.            enter their birthdate.  If toggled to Yes, the birthdate will
  124.            be required and if toggled to No, the user will not be prompted
  125.            to enter their birthdate.  
  126.                          
  127.            **NOTE**    SPITFIRE uses a caller's birthdate as the second
  128.                        password, when required.  It is not possible to
  129.                        require a second password if the BBS does not
  130.                        require the caller to enter their birthdate.
  131.                        Therefore, the SPITFIRE Second Password feature
  132.                        will not be operative if the New User Birthdate
  133.                        requirement is turn off.
  134.  
  135.  
  136.       <G>  Scan All Msg Conferences
  137.  
  138.            This feature allows the Sysop to designate the
  139.            message scan parameters.  When set to Yes, all 
  140.            message conferences are included in the scan.  When
  141.            set to No, only messages in the caller's queued
  142.            conferences are scanned.  This affects both the
  143.            log-on message scan and the scan done by selecting
  144.            <Y>...Your Message option from the Message Menu.
  145.  
  146.       <H>  Comprehensive Upload Search
  147.  
  148.            This feature allows the Sysop to configure SPITFIRE to perform
  149.            a comprehensive file search prior to a caller performing an
  150.            upload.  When this feature is turned SPITFIRE will trim all
  151.            numeric characters from the end of the file name and compare
  152.            that file name against all existing file names by trimming the
  153.            numeric characters from those file names.  For example, if
  154.            the caller told SPITFIRE that DSZ0691.ZIP was going to be
  155.            uploaded then SPITFIRE would then trim the '0691' from the file
  156.            and search for DSZ*.*.  Now let's say that SPITFIRE finds
  157.            DSZ0591.ZIP on the drive.  The caller would be advised that
  158.            DSZ0591.ZIP already exists and then asked if DSZ0691.ZIP is
  159.            still to be uploaded.  When this feature is turned off, then
  160.            SPITFIRE searches only for the exact file name.
  161.  
  162.       <I>  Test Files Upon Boot
  163.  
  164.            This feature allows the Sysop to configure SPITFIRE to perform
  165.            a comprehensive test of the message base files when booting. This
  166.            can be somewhat time consuming when the board has a large number
  167.            of Message Conferences.  It is recommended that this feature be
  168.            turned on.
  169.  
  170.       <J>  Door Return Password
  171.  
  172.            This feature allows the Sysop to configure SPITFIRE to require
  173.            a caller to enter their password when returning to SPITFIRE
  174.            from a door.  When this feature is toggled on, then SPITFIRE
  175.            will require a caller to enter their password when they return
  176.            to SPITFIRE from a door.  This is for the protection of your
  177.            board and for your caller's protection.
  178.  
  179.       <K>  Search CD Rom Area SFFILES
  180.  
  181.            This feature allows the Sysop to configure SPITFIRE to search
  182.            (or not search) File Areas marked as CD-Rom areas.  In other
  183.            words, before SPITFIRE allows a caller to make an upload it
  184.            tests to determine whether the file to be uploaded already
  185.            exists.  When a CD-Rom(s) is being used, then process can be
  186.            extremely slow.  So, when this switch is turned off, SPITFIRE
  187.            will not search File Areas marked as CD-Rom areas which will
  188.            make the search much faster.
  189.  
  190.     NUMERIC VALUES
  191.     --------------
  192.     
  193.         This option will allow modification to be made to any of the 
  194.     following numerical values:
  195.     
  196.  
  197.        <A>  Caller Number
  198.  
  199.              This gives you the opportunity to set the number of callers.  
  200.              The reason for this is if you are already running an 
  201.              established board, you can enter the the current number of 
  202.              callers, so as not to start the BBS with Caller Number 1.
  203.  
  204.         
  205.        <B>  Number Of Calls Today
  206.        
  207.              This sets the limit of how many times a user can call your 
  208.              board per day.  If this amount is exceeded, the system will 
  209.              display TOOMANY.BBS and log the user off.
  210.               
  211.  
  212.        <C>  Messages Today
  213.        
  214.              This option is used to set the total number of messages
  215.              left on your BBS for the current day.
  216.  
  217.  
  218.        <D>  Uploads Today
  219.        
  220.              This option is used to set the total number of files 
  221.              uploaded to your BBS for the current day.
  222.              
  223.  
  224.        <E>  Downloads Today
  225.        
  226.              This option is used to set the total number of files 
  227.              downloaded from your BBS for the current day.
  228.        
  229.  
  230.        <F>  Daily Time Limit
  231.  
  232.              Sets the amount of time per day, per user. 
  233.        
  234.  
  235.        <G>  Daily Log On Limit
  236.        
  237.              Sets the amount of time per call, per user. 
  238.  
  239.        
  240.        <H>  Log On Time Limit
  241.             
  242.              Sets the amount of time per day a user is allowed on the board.
  243.        
  244.  
  245.        <I>  New User Security
  246.  
  247.              Allows you to set the default security level for a new user.
  248.                
  249.  
  250.        <J>  New User 1st Day Time
  251.  
  252.              Allows you to set the amount of time on the board for the new 
  253.              user's visit.  (First day only)
  254.        
  255.  
  256.        <K>  # File Description Lines
  257.        
  258.              This option can be used to set the number of file description
  259.              lines allowed.  SPITFIRE allows a range of 1 to 4 lines.  The
  260.              name of the caller who uploaded the file is an additional above
  261.              and beyond this configured value.
  262.        
  263.  
  264.        <L>  Maximum Amount Of Users
  265.  
  266.              Determines the amount of users you will allow to utilize your 
  267.              BBS.  (i.e. -  If you have this value set at 500 and you already 
  268.              have 500 users and a new user (501) tries to log on, the system 
  269.              displays the file MAXUSERS.BBS and logs the user off.)
  270.                
  271.  
  272.        <M>  Number Of Nodes
  273.  
  274.              This option allows you to set the number of nodes operating
  275.              on your SPITFIRE BBS System.
  276.  
  277.  
  278.        <N>  No Keystroke Time Limit 
  279.     
  280.              This option sets the time in minutes that a caller is allowed
  281.              to elapse without entering any keystrokes on the BBS.  Once
  282.              this time has passed, the caller will automatically be
  283.              logged off.  If available, SFASLEEP.BBS/CLR will be displayed
  284.              to the caller prior to the automatic log off.
  285.  
  286.        <O>   U/D Ratio Violation Security
  287.  
  288.               This specifies the security level that a caller
  289.               will be changed to if the upload/download ratio
  290.               is violated and all other conditions are met.  Please
  291.               refer to the SPITFIRE manaul for additional details.
  292.  
  293.        <P>    Upload Disk Requirement
  294.  
  295.               This allows the Sysop to configure the amount of disk space
  296.               required before SPITFIRE will allow any uploads to be made.
  297.               The value configured is in K bytes.  Additionally, LAKOTA
  298.               uses this variable to determine whether there is enough
  299.               disk space avaialable to import/export messages.
  300.  
  301.       
  302.     SYSOP DATA
  303.     ----------
  304.     
  305.        <A>  Sysop's Name
  306.  
  307.              Allows you to change the name of the System Operator of the
  308.              BBS.  This is the name callers will see credited as the 
  309.              Sysop when first logging onto a SPITFIRE Bulletin Board System.  
  310.              In most incidences, you will want to use your real name here.
  311.                     
  312.        <B>  Sysop User Name
  313.        
  314.              This option will allow you to change the Sysop User Name.
  315.              Standard practice usually dictates that the "Sysop" be
  316.              used as the Sysop User Name.  If any other name is used,
  317.              callers will be unable to use the Comment To Sysop option
  318.              from the Main Menu.
  319.              
  320.        <C>  Drop To DOS Password 
  321.  
  322.              Sets the password that is needed to drop to DOS from a
  323.              remote location.  The default is blank (nothing), but you
  324.              will wish to use the 'Drop To DOS' feature then you must
  325.              configure this password.  This password is disguised for
  326.              security purposes.
  327.        
  328.        <D>  BBS Starting Date
  329.            
  330.             This provides an opportunity to set the starting date
  331.             of your bulletin board.  The reason for this is if you
  332.             are already running an established board, you can 
  333.             enter the original starting date of your BBS 
  334.             rather than the date of your conversion to SPITFIRE.       
  335.        
  336.        <E>  Sysop Security Level
  337.  
  338.              This allows you to set the security setting for users
  339.              you will grant Sysop status.  Callers with a security
  340.              equal to or greater than the Sysop Security Level have
  341.              certain privileges not available to most users.  For
  342.              example, a user with Sysop status can <U>..Undelete
  343.              deleted messages.  Refer to the SPITFIRE manual 
  344.              section - Special Commands For Sysop Status - for a
  345.              more detailed explanation of Sysop status.
  346.              
  347.  
  348.     USAGE AS A SCHEDULED EVENT
  349.     --------------------------
  350.     
  351.        The inclusion of the command line usage parameters provide some
  352.     unique opportunities in the configuration of your SPITFIRE BBS.  A
  353.     brief description of each follows.    
  354.  
  355.  
  356.     /L[x] = Log On Time Limit..................[x] = Number Of Minutes
  357.  
  358.     The /L[x] allows you to configure the maximum number of minutes 
  359.     a caller to your BBS is permitted for each log on.  For instance,
  360.     if you wish to set the limit to 60, you would use /L60.  If a
  361.     caller exceeds this, SFTIMEUP.BBS/CLR will be displayed to the
  362.     caller and the caller will be logged off the BBS.
  363.   
  364.     
  365.     /O[x] = Daily Log On Limit.................[x] = Amount Of Log Ons
  366.   
  367.     The /O[x] allows you to configure the amount of times you will
  368.     allow callers to access your system each day.  For instance,
  369.     if you wish to limit the number of times a caller can log on
  370.     your BBS to 5 times per day, you would use /O5.   If a caller
  371.     attempts to exceed the number of allowable daily log ons you 
  372.     have configured, TOOMANY.BBS/CLR will be displayed, if available,
  373.     and the caller will be logged off.
  374.  
  375.  
  376.     /T[x] = Daily Time Limit...................[x] = Number Of Minutes
  377.  
  378.     The /R[x] allows you to configure the total number of minutes
  379.     a caller will be permitted to use each day on your BBS.  For
  380.     instance, if you wish to set the total number of minutes allowed
  381.     on your BBS each day to 90, you would use /T90.  If a caller is
  382.     logged on the BBS and exceeds their allotted daily time limit,
  383.     SFTIMEUP.BBS/CLR (if found) will be displayed to the caller and
  384.     the caller will be logged off the BBS.  If a caller attempts 
  385.     to log onto the BBS after exceeding the allowable daily time
  386.     limit, SFNOTIME.BBS/CLR (if found) is displayed to the caller
  387.     and the caller is denied access to the BBS.
  388.  
  389.        Previously you could only configure your BBS to allow a set
  390.     log on time limit.  With SFSYSTEM.EXE it is possible to allow,
  391.     for instance, a 60 minute log on time limit during the less active
  392.     hours of BBS activity and decrease this amount to 45 minutes when
  393.     the board is at its busiest.   This is one example of the
  394.     possibilities now available using SFSYSTEM's command line
  395.     parameters and SPITFIRE's scheduled events.  
  396.     
  397.     /V[x] = U/D Ratio Violation Security........[x] = Altered Security Level
  398.  
  399.     This specifies the security level that a caller will be changed to
  400.     if the upload/download ratio is violated and all other conditions
  401.     are met:
  402.  
  403.  
  404.     /B- = NU Birthdate Not Required           /B+ = NU Birthdate Required
  405.       
  406.     The /B- configures your BBS so new users will not be required to
  407.     to provide their birthdate while the /B+ parameter configures your
  408.     BBS so new users will be required to provide their birthdate.  The
  409.     second password feature within SPITFIRE will not be operable when
  410.     the birthdate is not required.
  411.  
  412.     /D- = Unrequired Door Return Password     /D+ = Require Door Password
  413.  
  414.     The /D- configures your BBS so callers will not be required to enter
  415.     their password when returning from a door while the /D+ configures
  416.     your BBS so callers will be required to enter their password when
  417.     returning from a door.
  418.  
  419.     /F- = Test Files Upon Boot Turned Off     /F+ = Test Files Upon Boot
  420.  
  421.     The /F- configures SPITFIRE to avoid performing a comprehensive test
  422.     of the message base files when booting while the /F+ configures
  423.     SPITFIRE to perform a comprehensive test of the message base files.
  424.  
  425.     /P- = NU Default Procotol Off             /P+ = NU Default Procotol On
  426.  
  427.      The /P- configures your BBS so new users will not be given the 
  428.      opportunity to select a default file transfer protocol while the 
  429.      /P+ parameter configures your BBS so new users will be given the
  430.      opportunity to select a default file transfer protocol.  Regardless
  431.      of this configuration, users will still be able to select a default
  432.      protocol by using the <Y>our Statistics from the SPITFIRE Main Menu.
  433.  
  434.  
  435.     /S- = Scan Queued Msg Conferences Only    /S+ = Scan All Msg Conferences
  436.  
  437.      The /S- configures your BBS to scan only the user's queued message
  438.      conferences when logging on your board and/or when using the <Y>our
  439.      Messages feature from the Message Menu while the /S+ parameter 
  440.      configures your BBS to scan all message conferences.
  441.  
  442.        The procedure for using the command line parameters is the same
  443.     for each of these options.  The syntax for using the SFSYSTEM with 
  444.     the command line parameters is this to enter SFSYSTEM, a blank space 
  445.     and then the command line parameter you wish to use for configuring 
  446.     your system.  For instance:
  447.     
  448.     SFSYSTEM /R10     (This would establish an upload-download
  449.                        ratio of 1 to 10)
  450.                        
  451.     This documentation will take you through the steps of toggling the 
  452.     log on time limit from 60 to 45 minutes as a scheduled event.  The 
  453.     remaining options can be set up using SPITFIRE's scheduled events 
  454.     in much the same way.                       
  455.          
  456.        To set up the log on time limit of 60 minutes as a scheduled event,
  457.     you will need to select Create An Event from the Event's Menu (available
  458.     at the SPITFIRE Ready For Use prompt by pressing ALT+E simultaneously or
  459.     from the Sysop utilities menu).  Next select A as the event to be created.
  460.     You are then prompted for the time the event will be performed.  Let's
  461.     assume you will enter 01:00.  Next, you are prompted for the day the 
  462.     event will be performed.  Let's assume you wish to run the event daily,
  463.     so enter 7.
  464.  
  465.        Following the same procedure a second event will need to be created
  466.    to toggle the log on time limit to 45 minutes during the busiest hours of 
  467.    your BBS.  Again, let's assume your BBS gets its busiest around 6 pm.
  468.    Again, create an event using the Event's Menu, only this time select B 
  469.    as the event to be created.  You are then prompted for the time the event
  470.    will be performed.  Enter 18:00.  You will want this event to run daily
  471.    also, so once again, when prompted for the day the event will be performed,
  472.    enter 7.   
  473.  
  474.        Now, using your favorite text editor, the SF.BAT file for Event A 
  475.     and Event B will look like this:
  476.              
  477.          :EVENT_A
  478.            REM Place Event Commands Here
  479.          GOTO LOOP
  480.          :EVENT_B
  481.            REM Place Event Commands Here
  482.          GOTO LOOP
  483.       
  484.        What is required next is to include all necessary DOS commands
  485.     which are needed to toggle the log on time limit from 45 to 60 minutes
  486.     with the SFSYSTEM utility and enter those in place of the "REM Place 
  487.     Event Commands Here".  A completed SF.BAT for Event A and Event B
  488.     would appear as:
  489.              
  490.          :EVENT_A
  491.            CD\SF\WORK
  492.            SFSYSTEM /L60
  493.            CD\SF
  494.          GOTO LOOP
  495.          :EVENT_B
  496.            CD\SF\WORK
  497.            SFSYSTEM /L45
  498.            CD\SF
  499.          GOTO LOOP
  500.  
  501.        With these events set up in the previously described manner, 
  502.     every morning at 1:00 am, EVENT_A will execute SFSYSTEM to modify your 
  503.     SPITFIRE BBS configuration to allow a log on time limit of 60 minutes.  
  504.     Then each evening at 6:00 pm, EVENT-B will execute SFSYSTEM to
  505.     modify your BBS configuration to reduce the log on time limit to 45
  506.     minutes.
  507.     
  508.     
  509.     
  510.     IMPORTANT NOTE
  511.     --------------
  512.     
  513.        SFSYSTEM should NOT be executed by jumping to DOS and modifying
  514.     parameters will SPITFIRE is in memory.  SPITFIRE holds the established
  515.     settings in memory so before the changes can be effective, SPITFIRE
  516.     must be re-booted.  You MUST exit out of SPITFIRE by pressing F10
  517.     or the changes you make will not be effective.     
  518.  
  519.  
  520.     DISTRIBUTION
  521.     ------------
  522.  
  523.        SFSYSTEM is distributed under the shareware concept.  You are
  524.     free to distribute the SFSYSTEM program as long as it remains
  525.     unmodified and no fee is charged.  If you use this program and
  526.     find it beneficial a fee is required.  A $1.00 fee is required
  527.     of registered SPITFIRE sysops and a $5.00 fee is required of
  528.     all others.  This registration should be mailed to the below
  529.     listed address.
  530.  
  531.                       BUFFALO CREEK SOFTWARE
  532.                       ATTN: Mike Woltz
  533.                       913 - 39th Street
  534.                       West Des Moines, Iowa 50265
  535.     
  536.     
  537.     DISCLAIMER
  538.     ----------
  539.  
  540.         
  541.          Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  542.      responsible for any damage incurred while operating SPITFIRE.  All 
  543.      responsibility lies with the user of the software.
  544.  
  545.  
  546.        The documentation for SFSYSTEM is contributed by Jacque Shipley
  547.     and The Mother Board BBS.  The shareware version of SPITFIRE 
  548.     and other SPITFIRE utilities are available for download from:
  549.  
  550.          Buffalo Creek's BBS              The Mother Board BBS
  551.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  552.            (515) 225-8496                    (515) 986-3464
  553.     38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  554.  
  555.     REVISION: SFSYSTEM Version 1.2 - March 20, 1992
  556.        SFSYSTEM was altered to comply with SPITFIRE v3.2.
  557.  
  558.     REVISION: SFSYSTEM Version 1.3 - March 3, 1993
  559.        SFSYSTEM was altered to comply with SPITFIRE v3.3.
  560.